home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d3 / anarkey2.arc / LOAD.DOC < prev    next >
Text File  |  1989-05-01  |  8KB  |  231 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.                                       LOAD
  10.                                The Anarkey Loader
  11.                                    User Manual
  12.  
  13.                                   Version 2.00
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.                                 Steven Calwas
  37.                                Moderne Software
  38.                                 P.O. Box 3638
  39.                           Santa Clara, CA 95055-3638
  40.  
  41.  
  42.                               _______
  43.                          ____|__     |               (tm)
  44.                       --|       |    |-------------------
  45.                         |   ____|__  |  Association of
  46.                         |  |       |_|  Shareware
  47.                         |__|   o   |    Professionals
  48.                       -----|   |   |---------------------
  49.                            |___|___|    MEMBER
  50.  
  51.  
  52.  
  53.  
  54.                               Copyright (C) 1989
  55.                                  Steven Calwas
  56.                               All rights reserved
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.  
  73.  
  74.                                Introduction
  75.                                ------------
  76.  
  77.    LOAD will read the contents of an ASCII text file and store each line,
  78. unexecuted, into the ANARKEY history buffer.  Although "regular" command
  79. lines are not executed before being stored, lines containing AKA definitions
  80. ARE processed as though they had been entered on the command line.  In other
  81. words, the AKA is defined.
  82.  
  83.    Once ANARKEY is installed, LOAD may be executed at any time and any
  84. number of times.  It will probably be useful to run LOAD immediately after
  85. installing ANARKEY to initialize your starting environment.  For example,
  86. you may define any AKAs and restore the contents of the history buffer from
  87. the previous computer session.  Later, a switch in tasks may warrant the use
  88. of a different set of AKAs.  LOAD can be run again to read and define these
  89. new definitions.
  90.   
  91.  
  92.  
  93.                              Loading a Disk File
  94.                              -------------------
  95.  
  96.    ANARKEY must already be installed in order for LOAD to store lines into
  97. its history buffer.  If ANARKEY is not installed, LOAD will display an error
  98. message and halt execution.
  99.  
  100.    NOTE: If invoked from a multiple-command input line or AKA, LOAD must be
  101. the very last command in the line.
  102.  
  103.    LOAD syntax is:
  104.  
  105.         LOAD [-options] filename [filename...]
  106.  
  107.    If you invoke LOAD with no arguments, a short usage message will be
  108. displayed.
  109.  
  110.    Normally, one or more file names will be specified on the LOAD command
  111. line.  Each file specification may contain the DOS wildcard characters '*'
  112. and '?'.  LOAD will perform the wildcard expansion and process each matching
  113. file in turn.
  114.  
  115.    Each file should contain standard ASCII text characters.  LOAD will read
  116. one line at a time from the file.  Blank lines and lines whose first word is
  117. "REM" are ignored.  Otherwise, the line is stored in the history buffer,
  118. unexecuted.  If there is not enough room in the buffer to store the line,
  119. lines are removed from the top of the buffer to make room.  (This operation
  120. is explained in detail in the "ANARKEY User Manual.")
  121.  
  122.    If the line is an AKA definition (specified by a colon in the first
  123. character position), it will be processed and added to the list of AKAs (or
  124. removed from the list if it is an un-define).  If there is not enough
  125. available AKA space to store the definition, LOAD will beep and display an
  126. error message.
  127.  
  128.    Lines longer than 255 characters and lines containing individual commands
  129. longer than 127 characters will be rejected by LOAD.  An error message
  130. stating the nature of the problem will be displayed and the offending line
  131. will then be discarded.  LOAD will continue reading any remaining lines in
  132. the file.
  133.  
  134.    LOAD assumes that the multiple-commands-per-line feature is active in all
  135. processed lines unless the line contains a SET, PATH or PROMPT command.  If
  136. one of these commands is encountered, LOAD handles it in the same manner as
  137. ANARKEY does, i.e. the remainder of the line is considered a single command.
  138. LOAD also assumes that SET, PATH and PROMPT are not assigned to an AKA, for
  139. example:
  140.  
  141.                               :S      SET
  142.  
  143.  
  144.  
  145.                           Command-Line Options
  146.                           --------------------
  147.  
  148.    Options may appear anywhere on the command line.  Each must be
  149. immediately preceded by a dash (-) character.  Options may be in upper or
  150. lower case.  The supported options are detailed in the remainder of this
  151. section.
  152.  
  153.  
  154. Calculating Required AKA Space
  155. ------------------------------
  156.  
  157.         -M      -- Display AKA Memory Requirements
  158.  
  159.    When -M is included on the command line, LOAD will read the contents of
  160. each specified file and accumulate the number of characters taken up by AKA
  161. definitions.  The file's contents are not loaded into the history buffer,
  162. nor are the AKA definitions processed.
  163.  
  164.    After all of the files have been scanned, LOAD will display the total
  165. amount of space the defined AKAs will require.  This value can then be used
  166. to allocate space for AKAs during ANARKEY installation (see the -A option in
  167. the "ANARKEY User Manual").
  168.  
  169.    LOAD does not keep track of AKAs that are defined more than once nor AKA
  170. un-definitions.  Any command read from the disk file that begins with the
  171. AKA definition character (colon, ':') is added to the accumulated total.
  172. Thus, if a disk file contained the following AKA definitions:
  173.  
  174.                :define         rem This is an AKA definition
  175.                :define         rem A new substitution string
  176.                :define
  177.  
  178. LOAD would include the lengths of all three lines in its total, even though
  179. the net result will require no AKA space.  (The above AKA definitions
  180. require no space because the second definition replaces the first one and
  181. the third "definition" undefines it completely, leaving nothing defined.)
  182.  
  183.    ANARKEY does not have to be installed to use LOAD with the -M option.
  184.  
  185.  
  186. Specifying the ANARKEY Process Number
  187. -------------------------------------
  188.  
  189.         -Pn     -- ANARKEY Process Number
  190.  
  191.    This option is identical to the -P option available on the ANARKEY
  192. installation line.  Please refer to the "ANARKEY User Manual" for details
  193. about when to use this option.
  194.  
  195.    The -P option will only be required in extremely rare instances.  If you
  196. installed ANARKEY without it, you will not need to use it for LOAD either.
  197.  
  198.  
  199. Suppressing Run-Time Messages
  200. -----------------------------
  201.  
  202.         -Q      -- Run in Quiet Mode
  203.  
  204.    When LOAD is running in quiet mode, informational messages, such as the
  205. name of the file being processed, are suppressed.  Error messages will still
  206. be displayed.
  207.  
  208.  
  209.  
  210.                            Comments and Suggestions
  211.                            ------------------------
  212.  
  213.    I would love to hear your suggestions, comments, and enhancement ideas
  214. concerning LOAD and the other programs in the ANARKEY software package.
  215. Please send your suggestions to:
  216.  
  217.                                 Steven Calwas
  218.                                Moderne Software
  219.                                 P.O. Box 3638
  220.                           Santa Clara, CA 95055-3638
  221.  
  222.                               _______
  223.                          ____|__     |               (tm)
  224.                       --|       |    |-------------------
  225.                         |   ____|__  |  Association of
  226.                         |  |       |_|  Shareware
  227.                         |__|   o   |    Professionals
  228.                       -----|   |   |---------------------
  229.                            |___|___|    MEMBER
  230.  
  231.